Charger 24 Click Driver

API for configuring and manipulating Charger 24 Click driver. More...

Topics
	Charger 24 Settings
	Settings of Charger 24 Click driver.
	Charger 24 MikroBUS Map
	MikroBUS pin mapping of Charger 24 Click driver.

Functions
void	charger24_cfg_setup (charger24_cfg_t *cfg)
	Charger 24 configuration object setup function.
err_t	charger24_init (charger24_t *ctx, charger24_cfg_t *cfg)
	Charger 24 initialization function.
void	charger24_enable_boost (charger24_t *ctx)
	Charger 24 enable boost function.
void	charger24_disable_boost (charger24_t *ctx)
	Charger 24 disable boost function.
void	charger24_enable_charging (charger24_t *ctx)
	Charger 24 enable charging function.
void	charger24_disable_charging (charger24_t *ctx)
	Charger 24 disable charging function.
uint8_t	charger24_get_stat_pin (charger24_t *ctx)
	Charger 24 get STAT pin function.
uint8_t	charger24_get_iok_pin (charger24_t *ctx)
	Charger 24 get IOK pin function.
uint8_t	charger24_get_status (charger24_t *ctx)
	Charger 24 get status function.

Detailed Description

API for configuring and manipulating Charger 24 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

charger24_cfg_setup()

void charger24_cfg_setup

(

charger24_cfg_t *

cfg

)

Charger 24 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See charger24_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

charger24_disable_boost()

void charger24_disable_boost

(

charger24_t *

ctx

)

Charger 24 disable boost function.

This function disables the reverse boost converter on the Charger 24 Click board.

Parameters

[in]

ctx

: Click context object. See charger24_t object definition for detailed explanation.

Note

None.

charger24_disable_charging()

void charger24_disable_charging

(

charger24_t *

ctx

)

Charger 24 disable charging function.

This function disables battery charging on the Charger 24 Click board.

Parameters

[in]

ctx

: Click context object. See charger24_t object definition for detailed explanation.

Note

None.

charger24_enable_boost()

void charger24_enable_boost

(

charger24_t *

ctx

)

Charger 24 enable boost function.

This function enables the reverse boost converter on the Charger 24 Click board.

Parameters

[in]

ctx

: Click context object. See charger24_t object definition for detailed explanation.

Note

None.

charger24_enable_charging()

void charger24_enable_charging

(

charger24_t *

ctx

)

Charger 24 enable charging function.

This function enables battery charging on the Charger 24 Click board.

Parameters

[in]

ctx

: Click context object. See charger24_t object definition for detailed explanation.

Note

None.

charger24_get_iok_pin()

uint8_t charger24_get_iok_pin

(

charger24_t *

ctx

)

Charger 24 get IOK pin function.

This function returns the logic state of the IOK pin.

Parameters

[in]

ctx

: Click context object. See charger24_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

charger24_get_stat_pin()

uint8_t charger24_get_stat_pin

(

charger24_t *

ctx

)

Charger 24 get STAT pin function.

This function returns the logic state of the STAT pin.

Parameters

[in]

ctx

: Click context object. See charger24_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

charger24_get_status()

uint8_t charger24_get_status

(

charger24_t *

ctx

)

Charger 24 get status function.

This function checks the battery charging status by polling the STAT pin.

Parameters

[in]

ctx

: Click context object. See charger24_t object definition for detailed explanation.

Returns

• CHARGER24_STATE_NO_INPUT - No input power,
• CHARGER24_STATE_CHARGE_DONE - Charging complete,
• CHARGER24_STATE_CHARGING - Charging in progress.

Note

None.

charger24_init()

err_t charger24_init	(	charger24_t *	ctx,
		charger24_cfg_t *	cfg )

Charger 24 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See charger24_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See charger24_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.